Interface IPsProcess

All Superinterfaces:
IPCObject, Process
All Known Implementing Classes:
IPsProcessImpl

public interface IPsProcess extends Process
Information provided by the PKI file:

    \class IpsProcess
    
    \brief IpsProcess is the process that handles intrusion prevention.
    
    \example network().getDevice("Router0").getProcess("IpsProcess")
    
Author:
Auto-generated
  • Method Details

    • setConfigLocation

      void setConfigLocation(String name)
      Information provided by the PKI file:
      
          \brief Sets the directory location.
          
          \param name, the directory location.
          
              
      Parameters:
      name - Takes in a parameter of name
    • getConfigLocation

      String getConfigLocation()
      Information provided by the PKI file:
      
          \brief Returns the config location directory for IPS.
          
          \return string, the config location directory for IPS.
          
              
      Returns:
      String Returns a String
    • getIpsAt

      String getIpsAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the IPS at the specified index.
          
          \param index, the index of the IPS of interest.
          
          \return string, the IPS at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      String Returns a String
    • getAclForIps

      String getAclForIps(String ipsName)
      Information provided by the PKI file:
      
          \brief Returns the ACL for the IPS with the specified name.
          
          \param ipsName, the name of the IPS of interest.
          
          \return string, the ACL for the IPS with the specified name.
          
              
      Parameters:
      ipsName - Takes in a parameter of ipsName
      Returns:
      String Returns a String
    • addIps

      void addIps(String ipsName, String aclName)
      Information provided by the PKI file:
      
          \brief Adds an IPS with the specified name and ACL.
          
          \param ipsName, the name of this IPS.
          \param aclName, the name of the ACL for this IPS.
          
              
      Parameters:
      ipsName - Takes in a parameter of ipsName
      aclName - Takes in a parameter of aclName
    • deleteIps

      boolean deleteIps(String ipsName)
      Information provided by the PKI file:
      
          \brief Removes the IPS from the list.
          
          \param ipsName, the name of the IPS of interest.
          
          \returns bool, true if successful, otherwise false.
          
              
      Parameters:
      ipsName - Takes in a parameter of ipsName
      Returns:
      boolean Returns a boolean
    • getIpsListSize

      int getIpsListSize()
      Information provided by the PKI file:
      
          \brief Returns the number of IPS configured.
          
          \return int, the number of IPS configured.
          
              
      Returns:
      int Returns a int
    • getRootSigCategory

      SignatureCategory getRootSigCategory()
      Information provided by the PKI file:
      
          \brief Returns the root signature category category.
          
          \return SignatureCategory, the SignatureCategory object.
          
              
      Returns:
      SignatureCategory Returns a SignatureCategory
    • getSubCategoryAt

      Category getSubCategoryAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the subcategory at the specified index.
          
          \param index, the index of the subcategory of interest.
          
          \return Category, the Category object at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      Category Returns a Category
    • getSubCategorySize

      int getSubCategorySize()
      Information provided by the PKI file:
      
          \brief Returns the subcategory size.
          
          \return int, the subcategory size.
          
              
      Returns:
      int Returns a int
    • getIcmpSignature

      ICMPSignature getIcmpSignature()
      Information provided by the PKI file:
      
          \brief Returns the ICMP signature.
          
          \return IcmpSignature, the IcmpSignature object.
          
              
      Returns:
      ICMPSignature Returns a ICMPSignature
    • setRetryCount

      void setRetryCount(int count)
      Information provided by the PKI file:
      
          \brief Sets the retry count.
          
          \param count, the retry count.
          
              
      Parameters:
      count - Takes in a parameter of count
    • getRetryCount

      int getRetryCount()
      Information provided by the PKI file:
      
          \brief Returns the retry count
          
          \return int, the retry count.
          
              
      Returns:
      int Returns a int
    • setNotifyLog

      void setNotifyLog(boolean val)
      Information provided by the PKI file:
      
          \brief Sets the syslog notification.
          
          \param val, true to enable syslog, false to disable it.
          
              
      Parameters:
      val - Takes in a parameter of val
    • isSysLogEnabled

      boolean isSysLogEnabled()
      Information provided by the PKI file:
      
          \brief Returns true if syslog is enabled, otherwise false.
          
          \return bool, true if syslog is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean